Clarify role_ids and published_states in API docs#12236
Open
Parthsuii wants to merge 1 commit intoIQSS:developfrom
Open
Clarify role_ids and published_states in API docs#12236Parthsuii wants to merge 1 commit intoIQSS:developfrom
Parthsuii wants to merge 1 commit intoIQSS:developfrom
Conversation
Updated API documentation to clarify usage of role_ids and published_states parameters.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Updates the MyData API documentation to clarify that role_ids and published_states parameters can be used multiple times in a single query (e.g., &role_ids=1&role_ids=6).
Which issue(s) this PR closes:
Special notes for your reviewer:
I updated the curl example and added "Multiple parameters can be used" to the relevant parameter descriptions to match the existing documentation style for fq.
Suggestions on how to test this:
View the updated MyData section in the API Guide to ensure the examples and parameter notes are clear and correctly formatted.
Does this PR introduce a user interface change?:
No.
Is there a release notes update needed for this change?:
Yes: Clarified documentation for filtering by multiple roles and states in MyData API.
Additional documentation:
N/A